

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Virtual Documents [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Virtual Document,Virtual Document Introduction,Virtual Document Master Document Element,Virtual Document Model Document Element,Virtual Document RTF Bookmarking In,Element,Element Model Document,Element Master Document,Element Documentation,Model Document,Model Document Overview, Virtual Document,Model Document Element,Enterprise Architect UML Toolbox,Enterprise Architect UML Toolbox Documentation Group,UML Toolbox,UML Toolbox Documentation Group,Documentation,Documentation Group, Enterprise Architect UML Toolbox,Documentation Elements,Master Document,Master Document Element,Master Document Overview, Virtual Document,Master Document RTF Bookmarks In,RTF Report,RTF Report Bookmarks, In Master Document Elements,Bookmark,Bookmark RTF, In Master Document Element">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Virtual Documents</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="testingreport.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="create_master_document.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_TextIndentedL2"><img src="virtual_documents.png" width="155" height="100" border="0" alt="virtual_documents"></p>
<p class="p_BodyText"><span class="f_BodyText" style="font-style: italic;">Virtual documents</span><span class="f_BodyText"> enable you to structure and filter your RTF reports by selecting, grouping and ordering individual packages independent of the organization of the </span><span class="f_UIControl">Project Browser</span><span class="f_BodyText">.</span><span class="f_UIControl"> </span><span class="f_BodyText">You can create separate virtual documents defining, say, Requirements, Use Cases or Design elements of a project, or you can combine these separate reports - retaining their own different formats - into a single generated document with common headers and footers and a central contents list. This combined document could apply your corporate standards.</span></p>
<p class="p_BodyText"><span class="f_BodyText">You generate </span><span class="f_BodyText">virtual documents</span><span class="f_BodyText"> in Enterprise Architect from individual </span><span class="f_BodyText" style="font-style: italic;"><a href="createadocumentobject.htm">Model Document</a></span><span class="f_BodyText"> elements. You can also, if required, combine several Model Documents under a </span><span class="f_BodyText" style="font-style: italic;"><a href="create_master_document.htm">Master Document</a></span><span class="f_BodyText"> package element.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Each Model Document element identifies its own template; for example, a specifically-designed Requirements template for a Requirements document, or a Use Case template for a section on Use Cases. The template is identified in a Tagged Value, and defines the content as </span><span class="f_BodyText" style="font-weight: bold;">either</span><span class="f_BodyText">:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">A list of packages (defined as attributes) in whatever order or combination is most appropriate to your requirements - </span><span class="f_BodyText">you can easily <a href="addpackagestoyourdocumentobjec.htm">add</a> or <a href="deleteapackagefromyourdoc.htm">delete</a> packages as necessary;</span><span class="f_Bulletlist1"> </span><span class="f_Bulletlist1" style="font-weight: bold;">or</span></li>
<li><span class="f_Bulletlist1">A standard model search (defined as Tagged Values) created within the </span><span class="f_UIControl"><a href="creating_search_filters.htm">Model Search</a></span><span class="f_Bulletlist1"> facility (note that diagram searches are not supported); when you generate the document, this search captures the required data throughout the model, and populates the document</span><span class="f_BodyText">.</span></li>
</ul>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Notes:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><ul style="text-indent: 0px; margin-left: 13px; list-style-position: outside;">
<li><span class="f_TiporNoteText">In a Model Document, you should not define both a list of packages and a search; if both are present, when you generate the document Enterprise Architect works from the package list only.</span></li>
<li><span class="f_TiporNoteText">You cannot use <a href="o526.htm">RTF Bookmarking</a> in </span><span class="f_TiporNoteText" style="font-style: italic;">Master Document </span><span class="f_TiporNoteText">elements, which</span><span class="f_TiporNoteText"> effectively replace RTF Bookmarking in Word.</span><br>
<span class="f_TiporNoteText">&nbsp;</span><br>
<span class="f_TiporNoteText">RTF Bookmarking requires each bookmark to be unique. When you generate a report with a standard RTF template (including in a single Model Document element), each bookmark </span><span class="f_TiporNoteText" style="font-style: italic;">is</span><span class="f_TiporNoteText"> unique and there is a 1:1 association between the Elements-details being generated and the elements in the repository. As Master Documents are intended to contain multiple sub-documents, the association ceases to be 1:1. There is no simple method that enables the generated data to be uniquely identified directly in association with the original element.</span></li>
</ul>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">You can control the sequence in which information is presented in the document; see the </span><span class="f_BodyText" style="font-style: italic;"><a href="rearrangethepackageorder.htm">Document Order</a></span><span class="f_BodyText"> topic.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Tip:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">You can create as many Model Documents as required, for as many combinations of information as required.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_TextIndentedL2">The Master Document element contains its own template Tagged Value, which defines the headers, footers and central contents list. You can <a href="import_rtf_template.htm">import your corporate standards template</a> and edit the Tagged Value to identify that.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Document Elements</span></p>
<p class="p_BodyText"><span class="f_BodyText">Along with the </span><span class="f_BodyText" style="font-style: italic;"><a href="document_artifact.htm">Document Artifact</a></span><span class="f_BodyText"> element</span><span class="f_Bulletlist1" style="font-style: italic;">, </span><span class="f_BodyText">the Master Document and Model Document elements are available from the </span><span class="f_UIControl">Documentation</span><span class="f_BodyText"> page of the Enterprise Architect UML </span><span class="f_UIControl">Toolbox</span><span class="f_BodyText"> (on the </span><span class="f_UIControl">Toolbox</span><span class="f_BodyText">, select </span><span class="f_MenuKeyField">More Tools | Documentation</span><span class="f_BodyText">).</span></p>
<p class="p_TextIndentedL2"><img src="doctool.png" width="171" height="69" border="0" alt="Doctool"></p>
<p class="p_BodyText"><span class="f_BodyText">When you drag the Master Document and Model Document elements onto a diagram, the following symbols display, respectively:</span></p>
<p class="p_TextIndentedL2"><img src="masterdoc.png" width="159" height="108" border="0" alt="MasterDoc"><span class="f_TextIndentedL2"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <img src="d_modeldocelement.png" width="114" height="92" border="0" alt="d_ModelDocElement"></span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
